Update OpenAPI generator to add param and field documentation#896
Merged
Update OpenAPI generator to add param and field documentation#896
Conversation
ashwinb
requested review from
dineshyv,
dltn,
hardikjshah,
raghotham,
sixianyi0721,
vladimirivic and
yanxi0830
as code owners
facebook-github-bot
added
the
CLA Signed
ashwinb
commented
Jan 29, 2025
| ) | ||
|
|
||
|
|
||
| @json_schema_type |
Contributor
Author
There was a problem hiding this comment.
I found a bunch of older cruft re: batch completion and misplaced types, etc. I fixed those in this update as well.
yanxi0830
approved these changes
Jan 29, 2025
yanxi0830
reviewed
Jan 29, 2025
| # add property docstring if available | ||
| property_doc = property_docstrings.get(property_name) | ||
| if property_doc: | ||
| # print(output_name, property_doc) |
Contributor
Author
There was a problem hiding this comment.
yes, I kept it on purpose as a reminder about where I had added this print. It took me a long time yesterday to figure out this doc stuff :)
yanxi0830
reviewed
Jan 29, 2025
| - name: Types | ||
| tags: | ||
| - AgentCandidate | ||
| - AgentConfig |
Contributor
There was a problem hiding this comment.
Is these x-tagGroups deleted on purpose?
Contributor
Author
There was a problem hiding this comment.
@yanxi0830 yes, on purpose. It was just noise. There is no point to generating separate Tags for component schemas.
raghotham
approved these changes
Jan 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We desperately need to document our APIs. This is the basic requirement of having a Spec :)
This PR updates the OpenAPI generator so documentation for request parameters and object fields can be properly added to the OpenAPI specs. From there, this should get picked by Stainless, etc.
Test Plan:
Updated client-sdk (See llamastack/llama-stack-client-python#104) and then ran:
cd tests/client-sdk LLAMA_STACK_CONFIG=../../llama_stack/templates/fireworks/run.yaml pytest -s -v inference/test_inference.py agents/test_agents.py